<?php
/**************************************************************************
	PHP Api Lib
	Copyright (C) 2009 Clinton Weiss

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
**************************************************************************/

$xmlCache = array();

class EsamApi
{
	private $apisite = "api.eve-online.com";

	/**
	 * Retrieves the cache dir as defined by PHP
	 *
	 * @return <type> 
	 */
	function getCacheDir()
	{
		return sys_get_temp_dir() . '/esam_cache/';
	}

	/**
	 * Cleans the URL into a file name
	 *
	 * @param <type> $url
	 * @return <type>
	 */
	function getPath($url)
	{
		$path = str_replace(" ", "_", $url);
		$path = str_replace("/", "_", $path);
		return $this->getCacheDir() . $path;
	}

	/**
	 * Loads a cached file, if it exists
	 *
	 * @param <type> $url
	 * @return <type>
	 */
	function loadFile($url)
	{
		$path = $this->getPath($url);
		$xml = null;

		if (file_exists($path))
		{
			$fp = fopen($path, "r");
			if ($fp)
			{
				$contents = fread($fp, filesize($path));
				fclose($fp);
				try
				{
					$xml = new SimpleXMLElement($contents);
					$cachedUntil = $xml->cachedUntil;
					if (empty($cachedUntil))
					{
						die("empty cache time");
					}
					$cachedUntil = strtotime($cachedUntil);

					$timenow = time();
					$gmTime = $timenow - date('Z', $timenow);

					if ($gmTime > $cachedUntil)
					{
						$xml = null;
					}
				} catch (Exception $ex)
				{
					$xml = null;
				}
			}
		}
		return $xml;
	}

	/**
	 * Saves text to a file for caching.
	 * 
	 * @param <type> $url
	 * @param <type> $contents
	 */
	function saveFile($url, $contents)
	{
		$path = $this->getPath($url);

		$fp = fopen($path, "w");
		if ($fp)
		{
			fwrite($fp, $contents);
			fclose($fp);
			chmod($path, 0600);
		}
	}

	function getContents($url)
	{
		$fullURL = $this->apisite . $url;
		return load($fullURL);
	}

	function getXML($url)
	{
		$error = false;
		if (!empty($xmlCache[$url]))
		{
			return $xmlCache[$url];
		}
		$xml = $this->loadFile($url);
		if (!empty($xml))
		{
			return $xml;
		}

		$contents = $this->getContents($url);
		$xml = null;
		try
		{
			$xml = new SimpleXMLElement($contents);
		} catch (Exception $ex)
		{
			$error = true;
			die("Unable to parse xml - " . $ex);
		}
		$this->saveFile($url, $contents);
		$contents = null; // Save memory now

		// Cache this temporarily to memory in case of reuse
		$xmlCache[$url] = $xml;

		return $xml;
	}

	public function isError()
	{
		return $error;
	}

	public function getCharacterSheet($userId, $apiKey, $charId)
	{
		$url = "/char/CharacterSheet.xml.aspx?";
		$url = addParam($url, "apiKey", $apiKey);
		$url = addParam($url, "characterID", $charId);
		$url = addParam($url, "userID", $userId);
		return $this->getXML($url);
	}

	public function getCharacters($user_id, $api_key)
	{
		$url = "/account/Characters.xml.aspx?";
		$url = addParam($url, "userID", $user_id);
		$url = addParam($url, "apiKey", $api_key);
		return $this->getXML($url);
	}

	public function getCorporationInfo($corp_id)
	{
		$url = "/corp/CorporationSheet.xml.aspx?";
		$url = addParam($url, "corporationID", $corp_id);
		return $this->getXML($url);
	}

	public function getAllianceList()
	{
		return $this->getXML("/eve/AllianceList.xml.aspx");
	}

	public function getCharacterOrCorporationInfo($name)
	{
		$url = "/eve/CharacterID.xml.aspx?";
		$url = addParam($url, "names", $name);
		return $this->getXML($url);
	}
}


	/**
	 * Adds the given parameter to the url
	 *
	 * @param <type> $url
	 * @param <type> $key
	 * @param <type> $value
	 * @return <type>
	 */
	function addParam($url, $key, $value)
	{
		return $url . $key . "=" . $value . "&";
	}

/**
 * See http://www.bin-co.com/php/scripts/load/
 * Version : 2.00.A
 */
function load($url,$options=array()) {
    $default_options = array(
        'method'        => 'get',
        'return_info'    => false,
        'return_body'    => true,
        'cache'            => false,
        'referer'        => '',
        'headers'        => array(),
        'session'        => false,
        'session_close'    => false,
    );
    // Sets the default options.
    foreach($default_options as $opt=>$value) {
        if(!isset($options[$opt])) $options[$opt] = $value;
    }

    $url_parts = parse_url($url);
    $ch = false;
    $info = array(//Currently only supported by curl.
        'http_code'    => 200
    );
    $response = '';

    $send_header = array(
        'Accept' => 'text/*',
        'User-Agent' => 'BinGet/1.00.A (http://www.bin-co.com/php/scripts/load/)'
    ) + $options['headers']; // Add custom headers provided by the user.

    if($options['cache']) {
        $cache_folder = '/tmp/php-load-function/';
        if(isset($options['cache_folder'])) $cache_folder = $options['cache_folder'];
        if(!file_exists($cache_folder)) {
            $old_umask = umask(0); // Or the folder will not get write permission for everybody.
            mkdir($cache_folder, 0777);
            umask($old_umask);
        }

        $cache_file_name = md5($url) . '.cache';
        $cache_file = joinPath($cache_folder, $cache_file_name); //Don't change the variable name - used at the end of the function.

        if(file_exists($cache_file)) { // Cached file exists - return that.
            $response = file_get_contents($cache_file);

             //Seperate header and content
            $separator_position = strpos($response,"\r\n\r\n");
            $header_text = substr($response,0,$separator_position);
            $body = substr($response,$separator_position+4);

            foreach(explode("\n",$header_text) as $line) {
                $parts = explode(": ",$line);
                if(count($parts) == 2) $headers[$parts[0]] = chop($parts[1]);
            }
            $headers['cached'] = true;

            if(!$options['return_info']) return $body;
            else return array('headers' => $headers, 'body' => $body, 'info' => array('cached'=>true));
        }
    }

    ///////////////////////////// Curl /////////////////////////////////////
    //If curl is available, use curl to get the data.
    if(function_exists("curl_init")
                and (!(isset($options['use']) and $options['use'] == 'fsocketopen'))) { //Don't use curl if it is specifically stated to use fsocketopen in the options

        if(isset($options['post_data'])) { //There is an option to specify some data to be posted.
            $page = $url;
            $options['method'] = 'post';

            if(is_array($options['post_data'])) { //The data is in array format.
                $post_data = array();
                foreach($options['post_data'] as $key=>$value) {
                    $post_data[] = "$key=" . urlencode($value);
                }
                $url_parts['query'] = implode('&', $post_data);

            } else { //Its a string
                $url_parts['query'] = $options['post_data'];
            }
        } else {
            if(isset($options['method']) and $options['method'] == 'post') {
                $page = $url_parts['scheme'] . '://' . $url_parts['host'] . $url_parts['path'];
            } else {
                $page = $url;
            }
        }

        if($options['session'] and isset($GLOBALS['_binget_curl_session'])) $ch = $GLOBALS['_binget_curl_session']; //Session is stored in a global variable
        else $ch = curl_init($url_parts['host']);

        curl_setopt($ch, CURLOPT_URL, $page) or die("Invalid cURL Handle Resouce");
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); //Just return the data - not print the whole thing.
        curl_setopt($ch, CURLOPT_HEADER, true); //We need the headers
        curl_setopt($ch, CURLOPT_NOBODY, !($options['return_body'])); //The content - if true, will not download the contents. There is a ! operation - don't remove it.
        if(isset($options['method']) and $options['method'] == 'post' and isset($url_parts['query'])) {
            curl_setopt($ch, CURLOPT_POST, true);
            curl_setopt($ch, CURLOPT_POSTFIELDS, $url_parts['query']);
        }
        //Set the headers our spiders sends
        curl_setopt($ch, CURLOPT_USERAGENT, $send_header['User-Agent']); //The Name of the UserAgent we will be using ;)
        $custom_headers = array("Accept: " . $send_header['Accept'] );
        if(isset($options['modified_since']))
            array_push($custom_headers,"If-Modified-Since: ".gmdate('D, d M Y H:i:s \G\M\T',strtotime($options['modified_since'])));
        curl_setopt($ch, CURLOPT_HTTPHEADER, $custom_headers);
        if($options['referer']) curl_setopt($ch, CURLOPT_REFERER, $options['referer']);

        curl_setopt($ch, CURLOPT_COOKIEJAR, "/tmp/binget-cookie.txt"); //If ever needed...
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
        curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);

        if(isset($url_parts['user']) and isset($url_parts['pass'])) {
            $custom_headers = array("Authorization: Basic ".base64_encode($url_parts['user'].':'.$url_parts['pass']));
            curl_setopt($ch, CURLOPT_HTTPHEADER, $custom_headers);
        }

        $response = curl_exec($ch);
        $info = curl_getinfo($ch); //Some information on the fetch

        if($options['session'] and !$options['session_close']) $GLOBALS['_binget_curl_session'] = $ch; //Dont close the curl session. We may need it later - save it to a global variable
        else curl_close($ch);  //If the session option is not set, close the session.

    //////////////////////////////////////////// FSockOpen //////////////////////////////
    } else { //If there is no curl, use fsocketopen - but keep in mind that most advanced features will be lost with this approch.
        if(isset($url_parts['query'])) {
            if(isset($options['method']) and $options['method'] == 'post')
                $page = $url_parts['path'];
            else
                $page = $url_parts['path'] . '?' . $url_parts['query'];
        } else {
            $page = $url_parts['path'];
        }

        if(!isset($url_parts['port'])) $url_parts['port'] = 80;
        $fp = fsockopen($url_parts['host'], $url_parts['port'], $errno, $errstr, 30);
        if ($fp) {
            $out = '';
            if(isset($options['method']) and $options['method'] == 'post' and isset($url_parts['query'])) {
                $out .= "POST $page HTTP/1.1\r\n";
            } else {
                $out .= "GET $page HTTP/1.0\r\n"; //HTTP/1.0 is much easier to handle than HTTP/1.1
            }
            $out .= "Host: $url_parts[host]\r\n";
            $out .= "Accept: $send_header[Accept]\r\n";
            $out .= "User-Agent: {$send_header['User-Agent']}\r\n";
            if(isset($options['modified_since']))
                $out .= "If-Modified-Since: ".gmdate('D, d M Y H:i:s \G\M\T',strtotime($options['modified_since'])) ."\r\n";

            $out .= "Connection: Close\r\n";

            //HTTP Basic Authorization support
            if(isset($url_parts['user']) and isset($url_parts['pass'])) {
                $out .= "Authorization: Basic ".base64_encode($url_parts['user'].':'.$url_parts['pass']) . "\r\n";
            }

            //If the request is post - pass the data in a special way.
            if(isset($options['method']) and $options['method'] == 'post' and $url_parts['query']) {
                $out .= "Content-Type: application/x-www-form-urlencoded\r\n";
                $out .= 'Content-Length: ' . strlen($url_parts['query']) . "\r\n";
                $out .= "\r\n" . $url_parts['query'];
            }
            $out .= "\r\n";

            fwrite($fp, $out);
            while (!feof($fp)) {
                $response .= fgets($fp, 128);
            }
            fclose($fp);
        }
    }

    //Get the headers in an associative array
    $headers = array();

    if($info['http_code'] == 404) {
        $body = "";
        $headers['Status'] = 404;
    } else {
        //Seperate header and content
        $header_text = substr($response, 0, $info['header_size']);
        $body = substr($response, $info['header_size']);

        foreach(explode("\n",$header_text) as $line) {
            $parts = explode(": ",$line);
            if(count($parts) == 2) $headers[$parts[0]] = chop($parts[1]);
        }
    }

    if(isset($cache_file)) { //Should we cache the URL?
        file_put_contents($cache_file, $response);
    }

    if($options['return_info']) return array('headers' => $headers, 'body' => $body, 'info' => $info, 'curl_handle'=>$ch);
    return $body;
} 
?>